dopal.core.ExtendedAzureusConnection

Package dopal :: Module core :: Class ExtendedAzureusConnection

[show private | hide private]

Type ExtendedAzureusConnection

  AzureusLink --+    
                |    
AzureusConnection --+
                    |
                   ExtendedAzureusConnection

Known Subclasses:: AzureusObjectConnection

Method Summary
	`__init__(self)`
	`__str__(self)`
	`establish_connection(self, force)` Establishes a connection with the Azureus server.
	`get_azureus_version(self)`
	`invoke_remote_method(self, object_id, method_name, method_args, raise_errors)`
	`is_connection_valid(self)` Returns a boolean value indicating if the current connection is still valid.
	`update_connection_details(self, connection_id, connection_data)`
	`_on_reconnect(self)` Hook for subclasses to be notified whenever a new connection has been made.
Inherited from AzureusConnection
	`get_new_request_id(self)`
	`_is_global_method_call(self, method_name, method_args)`
Inherited from AzureusLink
	`get_cgi_path(self, auth_details, include_password)`
	`handle_link_error(self, error, retry_count, saved)`
	`handle_link_repair(self, error, retry_count, saved)`
	`send_method_exchange(self, xml_data)`
None	`set_link_details(self, **kwargs)` Sets the details of where the Azureus server to connect to is located.
	`_send_data(self, request)`
	`_send_method_exchange(self, xml_data)`

Method Details

establish_connection(self, force=True)

Establishes a connection with the Azureus server.

By invoking this method, this will ensure that other methods defined by this class work correctly, as it will have references both to a connection ID, and the ID for the plugin interface.

The force argument determines whether server communication must take place or not. If True, then this object will communicate with the Azureus server - if False, then this object will only communicate with the Azureus server if it has no recorded information about the plugin interface.

This method has two uses, depending on the value of the force argument - it can be used to ensure that there is a valid recorded connection in place (if force is True), or it can be used just to ensure that other methods on this class will behave properly (if force is False).

If a new connection is established, then the _on_reconnect method will be invoked.

Parameters:: force - Boolean value indicating if communication with the server must take place or not (default is True).

Returns:: None

get_azureus_version(self)

: Since: DOPAL 0.56

is_connection_valid(self)

Returns a boolean value indicating if the current connection is still valid.

Returns:: True if the current established connection is still valid, False otherwise.

Raises:: NoEstablishedConnectionError - If this connection has not been established.

Invariant: This connection to have already been established.

_on_reconnect(self)

Hook for subclasses to be notified whenever a new connection has been made.

Generated by Epydoc 2.1 on Wed May 03 14:22:33 2006

http://epydoc.sf.net